.TH "Zebulon::Underwater::ReportMotorStatus1" 3 "13 Oct 2009" "Version 2" "zebulon" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Zebulon::Underwater::ReportMotorStatus1 \- 
.PP
Command message to set the desired thrust of a motor.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <reportmotorstatus1.h>\fP
.PP
Inherits \fBZebulon::MCU::Message\fP.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBReportMotorStatus1\fP ()"
.br
.RI "\fIConstructor. \fP"
.ti -1c
.RI "virtual \fB~ReportMotorStatus1\fP ()"
.br
.RI "\fIDestructor. \fP"
.ti -1c
.RI "virtual int \fBWriteMessageBody\fP (CxUtils::Packet &packet) const "
.br
.RI "\fIWrites the contents of the message payload to the packet. \fP"
.ti -1c
.RI "virtual int \fBReadMessageBody\fP (const CxUtils::Packet &packet)"
.br
.RI "\fIReads the contents of the message payload from the packet, and saves to internal data members. \fP"
.ti -1c
.RI "virtual void \fBPrint\fP () const "
.br
.ti -1c
.RI "virtual Message * \fBClone\fP () const "
.br
.RI "\fIMakes a clone of the message. \fP"
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "unsigned char \fBmMotor\fP"
.br
.RI "\fISee seabotix interface design specification for decoding byte information. \fP"
.ti -1c
.RI "unsigned char \fBmStatus\fP"
.br
.RI "\fIIndicates revision number of motor controller software. \fP"
.ti -1c
.RI "unsigned char \fBmFault\fP"
.br
.RI "\fIIndicates fault status. \fP"
.ti -1c
.RI "unsigned char \fBmCurrent\fP"
.br
.RI "\fIIndicates current being drawn by motor in tenths of amps. \fP"
.in -1c
.SH "Detailed Description"
.PP 
Command message to set the desired thrust of a motor. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "ReportMotorStatus1::ReportMotorStatus1 ()"
.PP
Constructor. 
.PP
< Address of motor reporting status.
.PP
< Indicates revision number of motor controller software.
.PP
< Indicates fault status.
.PP
< Indicates current being drawn by motor in tenths of amps. 
.SH "Member Function Documentation"
.PP 
.SS "int ReportMotorStatus1::ReadMessageBody (const CxUtils::Packet & packet)\fC [virtual]\fP"
.PP
Reads the contents of the message payload from the packet, and saves to internal data members. \fBParameters:\fP
.RS 4
\fIpacket\fP Packet to read from.
.RE
.PP
\fBReturns:\fP
.RS 4
4 on success, 0 on failure. 
.RE
.PP

.PP
Reimplemented from \fBZebulon::MCU::Message\fP.
.SS "int ReportMotorStatus1::WriteMessageBody (CxUtils::Packet & packet) const\fC [virtual]\fP"
.PP
Writes the contents of the message payload to the packet. \fBParameters:\fP
.RS 4
\fIpacket\fP Packet to write to.
.RE
.PP
\fBReturns:\fP
.RS 4
4 on success, 0 on failure. 
.RE
.PP

.PP
Reimplemented from \fBZebulon::MCU::Message\fP.
.SH "Member Data Documentation"
.PP 
.SS "unsigned char \fBZebulon::Underwater::ReportMotorStatus1::mMotor\fP"
.PP
See seabotix interface design specification for decoding byte information. Address of motor reporting status. 

.SH "Author"
.PP 
Generated automatically by Doxygen for zebulon from the source code.
